QueryCorporate
The QueryCorporate web service
XML- or JSON-based information exchange systems that use the Internet for direct application-to-application interaction. These systems can include programs, objects, messages, or documents. enables an external client system to query a Corporate and retrieve Corporate Summary details for any existing CMP Converged Monetisation Platform. The MDS Global product that supports customer care and billing for digital service providers. Corporate.
The following fields are not shown because this information is associated with the posting account In the Cloud Monetisation Platform, a billing entity that can be used to manage payments on one or more subscriptions or payments for services. An account can hold details such as payments or invoices. (which is available via the QueryAccount web service):
- Amount in Query
- Balance
- CC Status
- Account Type
- Overdue
The user A person with the capability to log in to the CMP GUI software, such as a customer service advisor or agent. must pass in a valid CMP Corporate Code in order to retrieve the associated Corporate Details.
Data sets exist for this web service, which enables the user to pass in a single value in order to retrieve a specific subset of information, such as:
- Address
- Discounts
The Posting Account Number is returned to the user if the request has been successful.
Submitting invalid data in the request will result in an error message.
QueryCorporate Request
The QueryCorporate tag instructs the Corporate Service to query a corporate. This request contains the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
ExternalReference |
String69 |
The client may use this identifier to correlate the request and the response. |
Optional |
|
CorporateCode |
String6 |
The Corporate Code for the Corporate to be queried. |
Mandatory |
|
Datasets |
Container |
Contains one or more of the following datasets:
|
Optional |
Sample QueryCorporate Request
QueryCorporate Response
The QueryCorporate response is the response to the QueryCorporate request. This contains the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
ExternalReference |
String69 |
Returned unmodified in the response. The client may use this identifier to correlate the request and the response. |
Optional |
|
CorporateBasic |
Container |
See CorporateBasic Response Container for details. |
Optional |
|
Address |
Container |
Choice of:
|
Optional |
CorporateBasic Response Container
The CorporateBasic response container is the response to the BASIC dataset when specified in the QueryCorporate request. It contains the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
CorporateCode |
String6 |
The Corporate to which the account will be added. If not specified, the Account will not be associated with any Corporate. |
Mandatory |
|
CorporateDescription |
String30 |
A full Description of the Corporate. |
Mandatory |
|
CompanyNumber |
String3 |
The Company Name to which the Account is attached. |
Mandatory |
|
GroupCode |
String6 |
The ID allocated to the Group by the system, if appropriate. |
Optional |
|
AddressNumber |
Integer8 |
The Account level delivery address number which is used to identify one of the several delivery addresses available. |
Mandatory |
|
EmailAddress |
String70 |
The customer contact Email Address. |
Optional |
|
PostingAccountNumber |
Integer0-99999999 |
Unique number to identify the Posting Account. |
Mandatory |
|
LastAmendedDate |
dateTime |
YYYY-MM-DDThh:mm:ssZ |
Optional |
Address Response Container
The Address response container is the response to the ADDRESS dataset when specified in the QueryCororate request. It has the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
AddressNumber |
Integer |
The Account level delivery address number which is one of the several delivery addresses available. |
Optional |
|
PersonalAddress |
Container |
The PersonalAddress container is returned when populated in CMP. |
Optional |
|
BusinessAddress |
Container |
The BusinessAddress container is returned when populated in CMP. |
Optional |
|
Last Amended Date |
dateTime |
The date and time at which the Account was last amended. YYYY-MM-DDThh:mm:ssZ |
Optional |
Only one address type, personal or business, can be set up at any one time. Therefore only the address that is populated in CMP is returned when an Account is queried specifying the ADDRESS dataset.
PersonalAddress Response Container
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
Title |
String10 |
The customer's appropriate title for example Mr, Mrs, Miss, Ms or Dr. This field is always mandatory but can be made optional via configuration if required. |
Mandatory |
|
Forename |
String50 |
Customer's first name. |
Optional |
|
MiddleName |
String20 |
Customer's middle name. |
Optional |
|
Surname |
String50 |
Customer's surname. |
Mandatory |
|
Address1 |
String60 |
Line one of the customer's address. |
Mandatory |
|
Address2 |
String60 |
Line one of the customer's address. |
Optional |
|
Address3 |
String60 |
Line one of the customer's address. |
Optional |
|
Address4 |
String60 |
Line one of the customer's address. |
Optional |
|
Address5 |
String60 |
Line one of the customer's address. |
Optional |
|
Postcode |
String10 |
Customer's post code. Must be entered without spaces. |
Optional |
|
DateOfBirth |
Date |
Customer's date of birth, in the format YYYY-MM-DD. |
Optional |
|
Gender |
String |
Choice of: Male, Female, Unknown or BLANK. |
Optional |
|
MaritalStatus |
String |
Choice of: Married, Single, Widowed, Divorced, Other, Seperated or BLANK. |
Optional |
|
DateOfResidence |
Date |
The date from which the customer has lived at the address specified, in the format YYYY-MM-DD. |
Optional |
|
CustomerType |
String10 |
Selected from one of the available Customer Types configured in CMP. |
Optional |
|
AddressType |
String10 |
Identifies if the customer is a home owner, renting, living with parents, council tenant etc. Configurable CMP list. |
Optional |
|
AddressCategory |
String10 |
Indicates property value. A category range relating to the address. Configurable CMP list. |
Optional |
|
Occupation |
String10 |
The customer's current occupation. Configurable CMP list. |
Optional |
|
IDType |
String10 |
The available type of ID used as proof of identity for example passport or driving license. Configurable CMP list. |
Optional |
|
IDNumber |
String30 |
The unique ID from the proof of identity. |
Optional |
|
TelephoneNumber |
String15 |
Customer's main contact telephone number. |
Optional |
|
EveningTelephoneNumber |
String15 |
Customer's additional telephone number they can be reached on. |
Optional |
|
FaxNumber |
String15 |
Customer's fax number. |
Optional |
CMP configuration controls which elements are mandatory and optional. Standard validation settings can be changed via setup: DISESETUP > 5. Subscriber Registration Set up > 15. Delivery Address Set Up > 8. Field Validation Maintenance. Enter 'P' for Personal Address.
BusinessAddress Response Container
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
CompanyName |
String60 |
Name of company. |
Mandatory |
|
Address1 |
String40 |
Line one of the company's address. |
Mandatory |
|
Address2 |
String40 |
Line two of the company's address. |
Optional |
|
Address3 |
String40 |
Line three of the company's address. |
Optional |
|
Address4 |
String40 |
Line four of the company's address. |
Optional |
|
Address5 |
String40 |
Line five of the company's address. |
Optional |
|
Postcode |
String10 |
Company's postcode. Must be entered without spaces. |
Optional |
|
CompanyTelephoneNumber |
String15 |
Company's main contact telephone number. |
Optional |
|
ContactTelephoneNumber |
String15 |
The individual's contact telephone number. |
Optional |
|
FaxNumber |
String15 |
Company's fax number |
Optional |
|
CompanyType |
String10 |
Indicates the type of company. Configurable CMP list. |
Optional |
|
AddressType |
String10 |
Identifies the company's address. Configurable CMP list. |
Optional |
|
AddressCategory |
String10 |
Indicates property value. A category range relating to the address can be configured. Configurable CMP list. |
Optional |
|
IndustrialClassificationCode |
String10 |
Indicates the industry the company resides. Configurable CMP list. |
Optional |
|
CompanyRegistration |
String25 |
Unique ID the company is registered to. |
Optional |
|
DateOfIncorporation |
Date |
The date the company register at the address specified, in the format YYYY-MM-DD. |
Optional |
|
Title |
String10 |
Company's contact title. |
Optional |
|
Forename |
String15 |
Company's contact first name. |
Optional |
|
MiddleName |
String10 |
Company's contact middle name. |
Optional |
|
Surname |
String25 |
Company's contact surname name. |
Optional |
|
JobTitle |
String30 |
Company's contact job title. |
Optional |
CMP configuration controls which elements are mandatory and optional. Standard validation settings can be changed via setup: DISESETUP > 5. Subscriber Registration Set up > 15. Delivery Address Set Up > 8. Field Validation Maintenance. Enter 'C' for Company Address.